<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.8.13"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>C++ Web Framework: /home/herik/CPPWebFramework/CPPWebFramework/cwf/session.h Source File</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/searchdata.js"></script>
<script type="text/javascript" src="search/search.js"></script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
 <tbody>
 <tr style="height: 56px;">
  <td id="projectlogo"><img alt="Logo" src="logo.png"/></td>
  <td id="projectalign" style="padding-left: 0.5em;">
   <div id="projectname">C++ Web Framework
   &#160;<span id="projectnumber">3.0</span>
   </div>
  </td>
 </tr>
 </tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.13 -->
<script type="text/javascript">
var searchBox = new SearchBox("searchBox", "search",false,'Search');
</script>
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
$(function() {
  initMenu('',true,false,'search.php','Search');
  $(document).ready(function() { init_search(); });
});
</script>
<div id="main-nav"></div>
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
     onmouseover="return searchBox.OnSearchSelectShow()"
     onmouseout="return searchBox.OnSearchSelectHide()"
     onkeydown="return searchBox.OnSearchSelectKey(event)">
</div>

<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0" 
        name="MSearchResults" id="MSearchResults">
</iframe>
</div>

<div id="nav-path" class="navpath">
  <ul>
<li class="navelem"><a class="el" href="dir_b2448bd9c6b97c57da490a507d179d6c.html">CPPWebFramework</a></li><li class="navelem"><a class="el" href="dir_3bacee99d34edff13677baafd8c3a47f.html">cwf</a></li>  </ul>
</div>
</div><!-- top -->
<div class="header">
  <div class="headertitle">
<div class="title">session.h</div>  </div>
</div><!--header-->
<div class="contents">
<div class="fragment"><div class="line"><a name="l00001"></a><span class="lineno">    1</span>&#160;<span class="comment">/*</span></div><div class="line"><a name="l00002"></a><span class="lineno">    2</span>&#160;<span class="comment"> Copyright 2017 Herik Lima de Castro and Marcelo Medeiros Eler</span></div><div class="line"><a name="l00003"></a><span class="lineno">    3</span>&#160;<span class="comment"> Distributed under MIT license, or public domain if desired and</span></div><div class="line"><a name="l00004"></a><span class="lineno">    4</span>&#160;<span class="comment"> recognized in your jurisdiction.</span></div><div class="line"><a name="l00005"></a><span class="lineno">    5</span>&#160;<span class="comment"> See file LICENSE for detail.</span></div><div class="line"><a name="l00006"></a><span class="lineno">    6</span>&#160;<span class="comment">*/</span></div><div class="line"><a name="l00007"></a><span class="lineno">    7</span>&#160;</div><div class="line"><a name="l00008"></a><span class="lineno">    8</span>&#160;<span class="preprocessor">#ifndef SESSION_H</span></div><div class="line"><a name="l00009"></a><span class="lineno">    9</span>&#160;<span class="preprocessor">#define SESSION_H</span></div><div class="line"><a name="l00010"></a><span class="lineno">   10</span>&#160;</div><div class="line"><a name="l00011"></a><span class="lineno">   11</span>&#160;<span class="preprocessor">#include &lt;QMap&gt;</span></div><div class="line"><a name="l00012"></a><span class="lineno">   12</span>&#160;<span class="preprocessor">#include &lt;atomic&gt;</span></div><div class="line"><a name="l00013"></a><span class="lineno">   13</span>&#160;<span class="preprocessor">#include &lt;QMutex&gt;</span></div><div class="line"><a name="l00014"></a><span class="lineno">   14</span>&#160;<span class="preprocessor">#include &lt;QObject&gt;</span></div><div class="line"><a name="l00015"></a><span class="lineno">   15</span>&#160;<span class="preprocessor">#include &lt;QThread&gt;</span></div><div class="line"><a name="l00016"></a><span class="lineno">   16</span>&#160;<span class="preprocessor">#include &lt;QDateTime&gt;</span></div><div class="line"><a name="l00017"></a><span class="lineno">   17</span>&#160;<span class="preprocessor">#include &lt;QStringList&gt;</span></div><div class="line"><a name="l00018"></a><span class="lineno">   18</span>&#160;<span class="preprocessor">#include &lt;QMutexLocker&gt;</span></div><div class="line"><a name="l00019"></a><span class="lineno">   19</span>&#160;<span class="preprocessor">#include &quot;qmapthreadsafety.h&quot;</span></div><div class="line"><a name="l00020"></a><span class="lineno">   20</span>&#160;<span class="preprocessor">#include &quot;cppwebframework_global.h&quot;</span></div><div class="line"><a name="l00021"></a><span class="lineno">   21</span>&#160;</div><div class="line"><a name="l00022"></a><span class="lineno">   22</span>&#160;CWF_BEGIN_NAMESPACE</div><div class="line"><a name="l00023"></a><span class="lineno">   23</span>&#160;</div><div class="line"><a name="l00024"></a><span class="lineno">   24</span>&#160;<span class="keyword">class </span><a class="code" href="class_configuration.html">Configuration</a>;</div><div class="line"><a name="l00025"></a><span class="lineno">   25</span>&#160;<span class="keyword">class </span><a class="code" href="class_request.html">Request</a>;</div><div class="line"><a name="l00026"></a><span class="lineno">   26</span>&#160;</div><div class="line"><a name="l00030"></a><span class="lineno"><a class="line" href="class_session.html">   30</a></span>&#160;<span class="keyword">class </span>CPPWEBFRAMEWORKSHARED_EXPORT <a class="code" href="class_session.html">Session</a></div><div class="line"><a name="l00031"></a><span class="lineno">   31</span>&#160;{</div><div class="line"><a name="l00032"></a><span class="lineno">   32</span>&#160;    <span class="keyword">friend</span> <span class="keyword">class </span><a class="code" href="class_http_read_request.html">HttpReadRequest</a>;</div><div class="line"><a name="l00033"></a><span class="lineno">   33</span>&#160;    <span class="keyword">friend</span> <span class="keyword">class </span><a class="code" href="class_request.html">Request</a>;</div><div class="line"><a name="l00034"></a><span class="lineno">   34</span>&#160;    QString id;</div><div class="line"><a name="l00035"></a><span class="lineno">   35</span>&#160;    QAtomicInteger&lt;qint64&gt; sessionTimeOut;</div><div class="line"><a name="l00036"></a><span class="lineno">   36</span>&#160;    QAtomicInteger&lt;qint64&gt; creationTime;</div><div class="line"><a name="l00037"></a><span class="lineno">   37</span>&#160;    QAtomicInteger&lt;qint64&gt; lastAccessedTime;</div><div class="line"><a name="l00038"></a><span class="lineno">   38</span>&#160;    QAtomicInteger&lt;qint64&gt; sessionExpirationTime;</div><div class="line"><a name="l00039"></a><span class="lineno">   39</span>&#160;    QAtomicInteger&lt;qint64&gt; timeOut;</div><div class="line"><a name="l00040"></a><span class="lineno">   40</span>&#160;    QAtomicInteger&lt;qint8&gt;  autoClearAttributes = 0;</div><div class="line"><a name="l00041"></a><span class="lineno">   41</span>&#160;    QAtomicInteger&lt;qint8&gt;  expired = 0;</div><div class="line"><a name="l00042"></a><span class="lineno">   42</span>&#160;    <a class="code" href="class_q_map_thread_safety.html">QMapThreadSafety&lt;QString, QObject*&gt;</a> attributes;</div><div class="line"><a name="l00043"></a><span class="lineno">   43</span>&#160;    <span class="keyword">mutable</span> QMutex mutex;</div><div class="line"><a name="l00044"></a><span class="lineno">   44</span>&#160;<span class="keyword">public</span>:</div><div class="line"><a name="l00048"></a><span class="lineno">   48</span>&#160;    <span class="keyword">explicit</span> <a class="code" href="class_session.html">Session</a>(<span class="keyword">const</span> QString &amp;<span class="keywordtype">id</span>, qint64 sessionTimeOut);</div><div class="line"><a name="l00049"></a><span class="lineno">   49</span>&#160;</div><div class="line"><a name="l00050"></a><span class="lineno">   50</span>&#160;</div><div class="line"><a name="l00051"></a><span class="lineno">   51</span>&#160;    ~<a class="code" href="class_session.html">Session</a>();</div><div class="line"><a name="l00056"></a><span class="lineno"><a class="line" href="class_session.html#a8c4e4bd7aa6d6fb16ab3dcdb5e892783">   56</a></span>&#160;    QObject *<a class="code" href="class_session.html#a8c4e4bd7aa6d6fb16ab3dcdb5e892783">getAttribute</a>(<span class="keyword">const</span> QString &amp;name) <span class="keyword">const</span> noexcept { <span class="keywordflow">return</span> attributes.value(name, <span class="keyword">nullptr</span>); }</div><div class="line"><a name="l00060"></a><span class="lineno">   60</span>&#160;    QStringList getAttributeNames();</div><div class="line"><a name="l00064"></a><span class="lineno"><a class="line" href="class_session.html#a30db82e0a4a27644eafba17b45a648e6">   64</a></span>&#160;    <span class="keyword">inline</span> qint64 <a class="code" href="class_session.html#a30db82e0a4a27644eafba17b45a648e6">getCreationTime</a>() const noexcept { <span class="keywordflow">return</span> creationTime; }</div><div class="line"><a name="l00068"></a><span class="lineno">   68</span>&#160;    QString getId() <span class="keyword">const</span>;</div><div class="line"><a name="l00072"></a><span class="lineno"><a class="line" href="class_session.html#abefcd2f77928404263a3583037d892e2">   72</a></span>&#160;    <span class="keyword">inline</span> qint64 <a class="code" href="class_session.html#abefcd2f77928404263a3583037d892e2">getLastAccessedTime</a>() const noexcept { <span class="keywordflow">return</span> lastAccessedTime; }</div><div class="line"><a name="l00076"></a><span class="lineno">   76</span>&#160;    <span class="keywordtype">void</span> validate();</div><div class="line"><a name="l00080"></a><span class="lineno"><a class="line" href="class_session.html#abc80e67b2310fa99f07528e1a3107a71">   80</a></span>&#160;    <span class="keyword">inline</span> <span class="keywordtype">void</span> <a class="code" href="class_session.html#abc80e67b2310fa99f07528e1a3107a71">invalidate</a>() noexcept { expired = 1; }</div><div class="line"><a name="l00086"></a><span class="lineno"><a class="line" href="class_session.html#a7fd8e74f40cb93cb23cb9a434c338717">   86</a></span>&#160;    <span class="keyword">inline</span> <span class="keywordtype">int</span> <a class="code" href="class_session.html#a7fd8e74f40cb93cb23cb9a434c338717">removeAttribute</a>(<span class="keyword">const</span> QString &amp;name) noexcept { <span class="keywordflow">return</span> attributes.<a class="code" href="class_q_map_thread_safety.html#a91e703ad03572023876108c2b7bc3540">remove</a>(name); }</div><div class="line"><a name="l00090"></a><span class="lineno"><a class="line" href="class_session.html#afe6cfc02c901d3f27924107067f83189">   90</a></span>&#160;    <span class="keyword">inline</span> <span class="keywordtype">void</span> <a class="code" href="class_session.html#afe6cfc02c901d3f27924107067f83189">addAttribute</a>(<span class="keyword">const</span> QString &amp;name, QObject *value) noexcept { attributes.<a class="code" href="class_q_map_thread_safety.html#a156afe871591b26ce155da6ce6409ad6">insert</a>(name, value); }</div><div class="line"><a name="l00094"></a><span class="lineno"><a class="line" href="class_session.html#a3b0c748a2347e6fbf9db640ebf552433">   94</a></span>&#160;    <span class="keyword">inline</span> <span class="keywordtype">bool</span> <a class="code" href="class_session.html#a3b0c748a2347e6fbf9db640ebf552433">getAutoClearAttributes</a>() const noexcept { <span class="keywordflow">return</span> autoClearAttributes; }</div><div class="line"><a name="l00098"></a><span class="lineno"><a class="line" href="class_session.html#af266c9e12b8bfbb89b2ba0618ebc7fd8">   98</a></span>&#160;    <span class="keyword">inline</span> <span class="keywordtype">void</span> <a class="code" href="class_session.html#af266c9e12b8bfbb89b2ba0618ebc7fd8">setAutoClearAttributes</a>(<span class="keywordtype">bool</span> value) noexcept { autoClearAttributes = value; }</div><div class="line"><a name="l00102"></a><span class="lineno">  102</span>&#160;    <span class="keywordtype">bool</span> isExpired();</div><div class="line"><a name="l00106"></a><span class="lineno"><a class="line" href="class_session.html#a5f8e0d9461d8d33792aa0e4d1c70d1e1">  106</a></span>&#160;    <span class="keyword">inline</span> qint64 <a class="code" href="class_session.html#a5f8e0d9461d8d33792aa0e4d1c70d1e1">getSessionTimeOut</a>() const noexcept { <span class="keywordflow">return</span> sessionTimeOut; }</div><div class="line"><a name="l00111"></a><span class="lineno">  111</span>&#160;    <span class="keywordtype">void</span> setSessionTimeOut(qint64 value);</div><div class="line"><a name="l00112"></a><span class="lineno">  112</span>&#160;};</div><div class="line"><a name="l00113"></a><span class="lineno">  113</span>&#160;</div><div class="line"><a name="l00114"></a><span class="lineno">  114</span>&#160;CWF_END_NAMESPACE</div><div class="line"><a name="l00115"></a><span class="lineno">  115</span>&#160;</div><div class="line"><a name="l00116"></a><span class="lineno">  116</span>&#160;<span class="preprocessor">#endif // SESSION_H</span></div><div class="ttc" id="class_session_html_afe6cfc02c901d3f27924107067f83189"><div class="ttname"><a href="class_session.html#afe6cfc02c901d3f27924107067f83189">Session::addAttribute</a></div><div class="ttdeci">void addAttribute(const QString &amp;name, QObject *value) noexcept</div><div class="ttdoc">This method add an attribute to the session. </div><div class="ttdef"><b>Definition:</b> session.h:90</div></div>
<div class="ttc" id="class_session_html_abefcd2f77928404263a3583037d892e2"><div class="ttname"><a href="class_session.html#abefcd2f77928404263a3583037d892e2">Session::getLastAccessedTime</a></div><div class="ttdeci">qint64 getLastAccessedTime() const noexcept</div><div class="ttdoc">Returns the time of the last session access. </div><div class="ttdef"><b>Definition:</b> session.h:72</div></div>
<div class="ttc" id="class_session_html_a3b0c748a2347e6fbf9db640ebf552433"><div class="ttname"><a href="class_session.html#a3b0c748a2347e6fbf9db640ebf552433">Session::getAutoClearAttributes</a></div><div class="ttdeci">bool getAutoClearAttributes() const noexcept</div><div class="ttdoc">getAutoClearAttributes </div><div class="ttdef"><b>Definition:</b> session.h:94</div></div>
<div class="ttc" id="class_q_map_thread_safety_html_a91e703ad03572023876108c2b7bc3540"><div class="ttname"><a href="class_q_map_thread_safety.html#a91e703ad03572023876108c2b7bc3540">QMapThreadSafety::remove</a></div><div class="ttdeci">int remove(const Key &amp;key)</div><div class="ttdoc">This method removes a specific element given a specific key. </div><div class="ttdef"><b>Definition:</b> qmapthreadsafety.h:231</div></div>
<div class="ttc" id="class_session_html_a8c4e4bd7aa6d6fb16ab3dcdb5e892783"><div class="ttname"><a href="class_session.html#a8c4e4bd7aa6d6fb16ab3dcdb5e892783">Session::getAttribute</a></div><div class="ttdeci">QObject * getAttribute(const QString &amp;name) const noexcept</div><div class="ttdoc">Returns a session attribute given a name. </div><div class="ttdef"><b>Definition:</b> session.h:56</div></div>
<div class="ttc" id="class_q_map_thread_safety_html_a156afe871591b26ce155da6ce6409ad6"><div class="ttname"><a href="class_q_map_thread_safety.html#a156afe871591b26ce155da6ce6409ad6">QMapThreadSafety::insert</a></div><div class="ttdeci">iterator insert(const Key &amp;key, const T &amp;value)</div><div class="ttdoc">This method inserts a new key and value in the map. </div><div class="ttdef"><b>Definition:</b> qmapthreadsafety.h:166</div></div>
<div class="ttc" id="class_request_html"><div class="ttname"><a href="class_request.html">Request</a></div><div class="ttdoc">The Request class holds all information about a http request. </div><div class="ttdef"><b>Definition:</b> request.h:27</div></div>
<div class="ttc" id="class_session_html_af266c9e12b8bfbb89b2ba0618ebc7fd8"><div class="ttname"><a href="class_session.html#af266c9e12b8bfbb89b2ba0618ebc7fd8">Session::setAutoClearAttributes</a></div><div class="ttdeci">void setAutoClearAttributes(bool value) noexcept</div><div class="ttdoc">setAutoClearAttributes </div><div class="ttdef"><b>Definition:</b> session.h:98</div></div>
<div class="ttc" id="class_http_read_request_html"><div class="ttname"><a href="class_http_read_request.html">HttpReadRequest</a></div><div class="ttdoc">The HttpReadRequest class is created automatically by the CppWebServer and inserted   in a QThreadPoo...</div><div class="ttdef"><b>Definition:</b> httpreadrequest.h:36</div></div>
<div class="ttc" id="class_q_map_thread_safety_html"><div class="ttname"><a href="class_q_map_thread_safety.html">QMapThreadSafety</a></div><div class="ttdoc">The QMapThreadSafety class is a thread safe QMap. </div><div class="ttdef"><b>Definition:</b> qmapthreadsafety.h:23</div></div>
<div class="ttc" id="class_session_html_a7fd8e74f40cb93cb23cb9a434c338717"><div class="ttname"><a href="class_session.html#a7fd8e74f40cb93cb23cb9a434c338717">Session::removeAttribute</a></div><div class="ttdeci">int removeAttribute(const QString &amp;name) noexcept</div><div class="ttdoc">Removes all the items that have the key key from the map. Returns the number of items removed which i...</div><div class="ttdef"><b>Definition:</b> session.h:86</div></div>
<div class="ttc" id="class_session_html_abc80e67b2310fa99f07528e1a3107a71"><div class="ttname"><a href="class_session.html#abc80e67b2310fa99f07528e1a3107a71">Session::invalidate</a></div><div class="ttdeci">void invalidate() noexcept</div><div class="ttdoc">Make a invalid session. </div><div class="ttdef"><b>Definition:</b> session.h:80</div></div>
<div class="ttc" id="class_session_html"><div class="ttname"><a href="class_session.html">Session</a></div><div class="ttdoc">The Session class holds information about a client session. </div><div class="ttdef"><b>Definition:</b> session.h:30</div></div>
<div class="ttc" id="class_configuration_html"><div class="ttname"><a href="class_configuration.html">Configuration</a></div><div class="ttdoc">All classes of C++ Web Framework are contained within the namespace CWF. </div><div class="ttdef"><b>Definition:</b> configuration.h:24</div></div>
<div class="ttc" id="class_session_html_a30db82e0a4a27644eafba17b45a648e6"><div class="ttname"><a href="class_session.html#a30db82e0a4a27644eafba17b45a648e6">Session::getCreationTime</a></div><div class="ttdeci">qint64 getCreationTime() const noexcept</div><div class="ttdoc">getCreationTime </div><div class="ttdef"><b>Definition:</b> session.h:64</div></div>
<div class="ttc" id="class_session_html_a5f8e0d9461d8d33792aa0e4d1c70d1e1"><div class="ttname"><a href="class_session.html#a5f8e0d9461d8d33792aa0e4d1c70d1e1">Session::getSessionTimeOut</a></div><div class="ttdeci">qint64 getSessionTimeOut() const noexcept</div><div class="ttdoc">Returns the session timeout. </div><div class="ttdef"><b>Definition:</b> session.h:106</div></div>
</div><!-- fragment --></div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated on Mon May 28 2018 11:09:08 for C++ Web Framework by &#160;<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.8.13
</small></address>
</body>
</html>
